This file contains API for Current Limit 4 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"
#include "drv_i2c_master.h"

Data Structures
struct	currentlimit4_t
	Current Limit 4 Click context object. More...
struct	currentlimit4_cfg_t
	Current Limit 4 Click configuration object. More...

Macros
#define	CURRENTLIMIT4_SENSITIVITY_A_PER_V 8.0
	Current Limit 4 sensitivity value.
#define	CURRENTLIMIT4_RILIM_DIVIDEND 1460000.0
#define	CURRENTLIMIT4_RILIM_OFFSET 110.0
#define	CURRENTLIMIT4_ADC_RESOLUTION 0x0FFF
	Current Limit 4 ADC setting.
#define	CURRENTLIMIT4_VREF_3V3 3.3
#define	CURRENTLIMIT4_VREF_5V 5.0
#define	CURRENTLIMIT4_DIGIPOT_MAX 5000
	Current Limit 4 digital potentiometer values.
#define	CURRENTLIMIT4_DIGIPOT_RES 256
#define	CURRENTLIMIT4_DIGIPOT_R8 330
#define	CURRENTLIMIT4_DIGIPOT_OFFSET 110
#define	CURRENTLIMIT4_ROUND_TO_NEAREST_INT 0.5
#define	CURRENTLIMIT4_ILIMIT_MIN 400
	Current Limit 4 current limit values.
#define	CURRENTLIMIT4_ILIMIT_DEFAULT 1000
#define	CURRENTLIMIT4_ILIMIT_MAX 3000
#define	CURRENTLIMIT4_STEP 10
	Current Limit 4 current limit calculation values.
#define	CURRENTLIMIT4_START_POS 10
#define	CURRENTLIMIT4_MEASURE_NUM 100
#define	CURRENTLIMIT4_POWER_GOOD 1
	Current Limit 4 power good indication states.
#define	CURRENTLIMIT4_POWER_GOOD_ERROR 0
#define	CURRENTLIMIT4_SET_DEV_ADDR 0x2E
	Current Limit 4 device address setting.
#define	CURRENTLIMIT4_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	currentlimit4_drv_t { CURRENTLIMIT4_DRV_SEL_ADC , CURRENTLIMIT4_DRV_SEL_I2C }
	Current Limit 4 Click driver selector. More...
enum	currentlimit4_return_value_t { CURRENTLIMIT4_OK = 0 , CURRENTLIMIT4_ERROR = -1 }
	Current Limit 4 Click return value data. More...

Functions
void	currentlimit4_cfg_setup (currentlimit4_cfg_t *cfg)
	Current Limit 4 configuration object setup function.
err_t	currentlimit4_init (currentlimit4_t ctx, currentlimit4_cfg_t cfg)
	Current Limit 4 initialization function.
err_t	currentlimit4_default_cfg (currentlimit4_t *ctx)
	Current Limit 4 default configuration function.
void	currentlimit4_enable (currentlimit4_t *ctx)
	Current Limit 4 enable function.
void	currentlimit4_disable (currentlimit4_t *ctx)
	Current Limit 4 disable function.
uint8_t	currentlimit4_get_power_good (currentlimit4_t *ctx)
	Current Limit 4 power good indication function.
err_t	currentlimit4_read_raw_adc (currentlimit4_t ctx, uint16_t raw_adc)
	Current Limit 4 read raw ADC value function.
err_t	currentlimit4_read_voltage (currentlimit4_t ctx, float voltage)
	Current Limit 4 read voltage level function.
err_t	currentlimit4_set_vref (currentlimit4_t *ctx, float vref)
	Current Limit 4 set vref function.
err_t	currentlimit4_get_current (currentlimit4_t ctx, float current)
	Current Limit 4 get current function.
err_t	currentlimit4_set_wiper_pos (currentlimit4_t *ctx, uint16_t wiper_pos)
	Current Limit 4 set wiper position function.
err_t	currentlimit4_set_res (currentlimit4_t *ctx, uint16_t res_ohm)
	Current Limit 4 set resistance function.
err_t	currentlimit4_set_limit (currentlimit4_t *ctx, uint16_t ilimit_ma)
	Current Limit 4 set current limit function.

Detailed Description

This file contains API for Current Limit 4 Click Driver.

Enumeration Type Documentation

Current Limit 4 Click driver selector.

Selects target driver interface of Current Limit 4 Click driver.

Enumerator
CURRENTLIMIT4_DRV_SEL_ADC	ADC driver descriptor.
CURRENTLIMIT4_DRV_SEL_I2C	I2C driver descriptor.

Current Limit 4 Click return value data.

Predefined enum values for driver return values.

Enumerator
CURRENTLIMIT4_OK
CURRENTLIMIT4_ERROR